-
Notifications
You must be signed in to change notification settings - Fork 619
Create datadog-synthetics.yml #7237
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Signed-off-by: Kareng1976 <[email protected]>
|
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. |
|
@Kareng1976 is attempting to deploy a commit to the thirdweb Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughA new GitHub Actions workflow file, Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant GitHub Actions
participant Datadog
Developer->>GitHub Actions: Push or PR to main branch
GitHub Actions->>GitHub Actions: Checkout repository code
GitHub Actions->>Datadog: Run Synthetic tests (using API and APP keys, filter by tag)
Datadog-->>GitHub Actions: Return test results
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (3)
.github/workflows/datadog-synthetics.yml (3)
14-21: Addworkflow_dispatchfor manual runs
You might want to support manual invocations (e.g.,workflow_dispatch) alongsidepush/pull_request, which enables on-demand synthetic test runs:on: workflow_dispatch:
32-32: Pinning the Datadog Action
Consider referencing the semantic version tag (@v1.4.0) rather than a raw commit SHA for readability, while still pinning to a fixed version. For example:- uses: DataDog/synthetics-ci-github-action@87b505388a22005bb8013481e3f73a367b9a53eb + uses: DataDog/[email protected]
33-37: Parametrizetest_search_query
If you plan to run multiple tag-based test suites, consider exposingtest_search_queryas a workflow input or an environment variable to avoid editing the workflow for each tag:with: test_search_query: '${{ inputs.TEST_TAGS || "tag:e2e-tests" }}'
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/datadog-synthetics.yml(1 hunks)
🔇 Additional comments (4)
.github/workflows/datadog-synthetics.yml (4)
1-8: Top-level comments formatting
The header comments are clear and reference the correct documentation. Ensure that they remain up-to-date if the Datadog Action docs move.
9-13: Confirm repository secrets are configured
Please verify thatDD_API_KEYandDD_APP_KEYare added to the repository’s secrets with the appropriate permission scopes. Consider adding a note to remind maintainers to rotate these keys periodically.
22-28: Checkout step is correctly configured
Usingactions/checkout@v4ensures the latest improvements. No changes needed here.
29-31: Step naming clarity
The step description “Run Datadog Synthetic tests” is clear and concise.
PR-Codex overview
This PR introduces a GitHub Actions workflow for running Datadog Synthetic tests. It outlines the setup process and includes necessary configurations for executing the tests within a GitHub repository.
Detailed summary
.github/workflows/datadog-synthetics.ymlRun Datadog Synthetic testspushandpull_requestevents on themainbranchubuntu-latestDataDog/synthetics-ci-github-actionapi_key,app_key, and atest_search_queryparameterSummary by CodeRabbit